Server Automation Guide - ScxV6Area.List Method

ScxV6Area.List Method

Returns an ScxV6Areas collection representing all areas of interest that are children of this area of interest.

Example:

The following example written in VB.NET moves one Area of Interest into another by iterating the ScxV6Areas collection of the World area for the correct Area of Interest.

Dim Svr As ScxV6DbClient.ScxV6Server

Dim Areas As ScxV6DbClient.ScxV6Areas

'Connect to the server

Svr = New ScxV6DbClient.ScxV6Server()

Svr.Connect("MAIN", "", "")

' Find the area of interest we want to move

Areas = Svr.RootArea.List

Dim AreaToMove As ScxV6DbClient.ScxV6Area

AreaToMove = Nothing

Dim TargetAreaId As Integer

For Each Area As ScxV6DbClient.ScxV6Area In Areas

If Area.Name = "Target" Then

TargetAreaId = Area.ID

ElseIf Area.Name = "Area 2" Then

AreaToMove = Area

End If

If (Not AreaToMove Is Nothing) Then

AreaToMove.Move(TargetAreaId)

End If

' Disconnect

Svr.Disconnect()